home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Communication / Citadel_BBS / Util / Citadel_msgadd.lha / msgadd.doc next >
Encoding:
Text File  |  1997-07-28  |  2.2 KB  |  52 lines
  1. MSGADD
  2.  
  3.    MSGADD is utility for use with programs which act as gateways
  4. between Citadel-compatible systems and other (foreign) networks.  Its
  5. purpose is to allow the addition of messages to a Citadel-86 message
  6. base.  The 'typical' system operator will rarely have a use for this
  7. utility.
  8.  
  9.    The command line format of MSGADD is
  10.  
  11.       C>MSGADD <options> <node name> <file names>
  12.  
  13.    <options>  are:
  14.  
  15.     -f    force the addition of messages which are for a room that
  16.           is not shared with <node name>.  The default is to reject
  17.           any messages which are for a room not shared.
  18.           Note:  a vortexed message will still be rejected even if this
  19.           flag is present.
  20.     -d    Debug output.  This will cause extra output to be printed
  21.           when the program runs.
  22.  
  23.    The node name, should be the name of a node on your nodelist, typically
  24.    (although not always) a node which has been designated OtherNet.  The
  25.    purpose of specifying a node name is to allow correct routing address
  26.    decisions to be made by MSGADD, which will in turn allow Citadel to
  27.    route messages from the foreign network to other Citadel systems.
  28.  
  29.    There should be at least one file name following the node name.  Each
  30.    file should contain at least one message from the foreign network in
  31.    C86Net message format (see NETHACK3.MAN for the complete specification).
  32.    Of all the fields that makes up a C86Net message, the following should
  33.    be filled in by the gateway program for each message:
  34.  
  35.         Author
  36.         Date
  37.         Name of Origin System - need not be 'node name' in the command line
  38.         Node ID of Origin System - a matter for some thought
  39.         Room for message - a MUST
  40.         Recipient if and only if msg is private mail
  41.         Message Text
  42.  
  43.    Attempting to add messages to rooms which are not shared with 'node
  44.    name' will result in warning messages, and the the messages will only be
  45.    inserted if you specify the -f (force) option.  By formally sharing rooms
  46.    with 'node name' you ensure that the companion utility to MSGADD, MSGOUT,
  47.    will pick up messages for the foreign net properly.  See MSGOUT.DOC.
  48.  
  49.    Vortex checking will be done on all messages.  A summary of the resulting
  50.    vortex processing will be issued at the end of the run.
  51.  
  52.